/*
 * Copyright 2013-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.cloud.gateway.handler.predicate;

import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;

import jakarta.validation.constraints.NotEmpty;

import org.springframework.http.HttpCookie;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.server.ServerWebExchange;

/**
 * @author Spencer Gibb
 * <p>
 *     CookieRoutePredicateFactory 是 Spring Cloud Gateway 中的一个具体实现类，
 *     用于定义 基于 Cookie 的路由谓词。它的作用是根据请求中特定名称的 Cookie 是否匹配指定的正则表达式来决定是否匹配该路由。
 *     以下是对其功能、设计和使用场景的详细解析。
 *
 * 4. 关键点总结
 * 4.1 核心职责
 * 判断请求中是否存在指定名称的 Cookie，并检查其值是否匹配正则表达式。
 * 支持快捷配置和动态配置。
 * 4.2 扩展性
 * 可以通过实现类似的谓词工厂创建其他基于请求属性的路由规则（如基于 Header 或 Query 参数）。
 * 4.3 使用范围
 * 主要用于基于 Cookie 的路由控制。
 * 适用于需要灵活配置和扩展的场景。
 *
 * </p>
 */
public class CookieRoutePredicateFactory extends AbstractRoutePredicateFactory<CookieRoutePredicateFactory.Config> {

	/**
	 * Name key.
	 */
	public static final String NAME_KEY = "name";

	/**
	 * Regexp key.
	 */
	public static final String REGEXP_KEY = "regexp";

	public CookieRoutePredicateFactory() {
		super(Config.class);
	}

	/**
	 * 功能：定义快捷配置的字段顺序。
	 * 场景：
	 * 在快捷配置中，name 和 regexp 是两个必须的参数。
	 * 示例：
	 * spring:
	 *   cloud:
	 *     gateway:
	 *       routes:
	 *         - id: example_route
	 *           uri: http://example.org
	 *           predicates:
	 *             - Cookie=user_token, ^[a-zA-Z0-9]{32}$
	 * @return
	 */
	@Override
	public List<String> shortcutFieldOrder() {
		return Arrays.asList(NAME_KEY, REGEXP_KEY);
	}

	@Override
	public Predicate<ServerWebExchange> apply(Config config) {
		return new GatewayPredicate() {
			@Override
			public boolean test(ServerWebExchange exchange) {
				List<HttpCookie> cookies = exchange.getRequest().getCookies().get(config.name);
				if (cookies == null) {
					return false;
				}
				for (HttpCookie cookie : cookies) {
					if (cookie.getValue().matches(config.regexp)) {
						return true;
					}
				}
				return false;
			}

			@Override
			public Object getConfig() {
				return config;
			}

			@Override
			public String toString() {
				return String.format("Cookie: name=%s regexp=%s", config.name, config.regexp);
			}
		};
	}

	@Validated
	public static class Config {

		@NotEmpty
		private String name;

		@NotEmpty
		private String regexp;

		public String getName() {
			return name;
		}

		public Config setName(String name) {
			this.name = name;
			return this;
		}

		public String getRegexp() {
			return regexp;
		}

		public Config setRegexp(String regexp) {
			this.regexp = regexp;
			return this;
		}

	}

}
